<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.commons.pool2;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
<span class="sourceLineNo">020</span> * An interface defining life-cycle methods for<a name="line.20"></a>
<span class="sourceLineNo">021</span> * instances to be served by a {@link KeyedObjectPool}.<a name="line.21"></a>
<span class="sourceLineNo">022</span> * &lt;p&gt;<a name="line.22"></a>
<span class="sourceLineNo">023</span> * By contract, when an {@link KeyedObjectPool}<a name="line.23"></a>
<span class="sourceLineNo">024</span> * delegates to a {@link KeyedPooledObjectFactory},<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;/p&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;ol&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> *  &lt;li&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> *   {@link #makeObject} is called whenever a new instance is needed.<a name="line.28"></a>
<span class="sourceLineNo">029</span> *  &lt;/li&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> *  &lt;li&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> *   {@link #activateObject} is invoked on every instance that has been<a name="line.31"></a>
<span class="sourceLineNo">032</span> *   {@link #passivateObject passivated} before it is<a name="line.32"></a>
<span class="sourceLineNo">033</span> *   {@link KeyedObjectPool#borrowObject borrowed} from the pool.<a name="line.33"></a>
<span class="sourceLineNo">034</span> *  &lt;/li&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> *  &lt;li&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> *   {@link #validateObject} may be invoked on {@link #activateObject activated}<a name="line.36"></a>
<span class="sourceLineNo">037</span> *   instances to make sure they can be<a name="line.37"></a>
<span class="sourceLineNo">038</span> *   {@link KeyedObjectPool#borrowObject borrowed} from the pool.<a name="line.38"></a>
<span class="sourceLineNo">039</span> *   {@code validateObject} may also be used to test an<a name="line.39"></a>
<span class="sourceLineNo">040</span> *   instance being {@link KeyedObjectPool#returnObject returned} to the pool<a name="line.40"></a>
<span class="sourceLineNo">041</span> *   before it is {@link #passivateObject passivated}. It will only be invoked<a name="line.41"></a>
<span class="sourceLineNo">042</span> *   on an activated instance.<a name="line.42"></a>
<span class="sourceLineNo">043</span> *  &lt;/li&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> *  &lt;li&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> *   {@link #passivateObject passivateObject}<a name="line.45"></a>
<span class="sourceLineNo">046</span> *   is invoked on every instance when it is returned to the pool.<a name="line.46"></a>
<span class="sourceLineNo">047</span> *  &lt;/li&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> *  &lt;li&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> *   {@link #destroyObject destroyObject}<a name="line.49"></a>
<span class="sourceLineNo">050</span> *   is invoked on every instance when it is being "dropped" from the<a name="line.50"></a>
<span class="sourceLineNo">051</span> *   pool (whether due to the response from {@code validateObject},<a name="line.51"></a>
<span class="sourceLineNo">052</span> *   or for reasons specific to the pool implementation.) There is no<a name="line.52"></a>
<span class="sourceLineNo">053</span> *   guarantee that the instance being destroyed will<a name="line.53"></a>
<span class="sourceLineNo">054</span> *   be considered active, passive or in a generally consistent state.<a name="line.54"></a>
<span class="sourceLineNo">055</span> *  &lt;/li&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * &lt;/ol&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> * {@link KeyedPooledObjectFactory} must be thread-safe. The only promise<a name="line.57"></a>
<span class="sourceLineNo">058</span> * an {@link KeyedObjectPool} makes is that the same instance of an object will<a name="line.58"></a>
<span class="sourceLineNo">059</span> * not be passed to more than one method of a<a name="line.59"></a>
<span class="sourceLineNo">060</span> * {@code KeyedPoolableObjectFactory} at a time.<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;p&gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span> * While clients of a {@link KeyedObjectPool} borrow and return instances of<a name="line.62"></a>
<span class="sourceLineNo">063</span> * the underlying value type V, the factory methods act on instances of<a name="line.63"></a>
<span class="sourceLineNo">064</span> * {@link PooledObject PooledObject&amp;lt;V&amp;gt;}.  These are the object wrappers that<a name="line.64"></a>
<span class="sourceLineNo">065</span> * pools use to track and maintain state informations about the objects that<a name="line.65"></a>
<span class="sourceLineNo">066</span> * they manage.<a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;/p&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> *<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @see KeyedObjectPool<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @see BaseKeyedPooledObjectFactory<a name="line.70"></a>
<span class="sourceLineNo">071</span> *<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param &lt;K&gt; The type of keys managed by this factory.<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @param &lt;V&gt; Type of element managed by this factory.<a name="line.73"></a>
<span class="sourceLineNo">074</span> *<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @since 2.0<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span>public interface KeyedPooledObjectFactory&lt;K, V&gt; {<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>    /**<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * Reinitializes an instance to be returned by the pool.<a name="line.80"></a>
<span class="sourceLineNo">081</span>     *<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @param key the key used when selecting the object<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @param p a {@code PooledObject} wrapping the instance to be activated<a name="line.83"></a>
<span class="sourceLineNo">084</span>     *<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * @throws Exception if there is a problem activating {@code obj},<a name="line.85"></a>
<span class="sourceLineNo">086</span>     *    this exception may be swallowed by the pool.<a name="line.86"></a>
<span class="sourceLineNo">087</span>     *<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * @see #destroyObject<a name="line.88"></a>
<span class="sourceLineNo">089</span>     */<a name="line.89"></a>
<span class="sourceLineNo">090</span>    void activateObject(K key, PooledObject&lt;V&gt; p) throws Exception;<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    /**<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * Destroys an instance no longer needed by the pool.<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * &lt;p&gt;<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * It is important for implementations of this method to be aware that there<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * is no guarantee about what state {@code obj} will be in and the<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * implementation should be prepared to handle unexpected errors.<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * &lt;/p&gt;<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * &lt;p&gt;<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * Also, an implementation must take in to consideration that instances lost<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * to the garbage collector may never be destroyed.<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * &lt;/p&gt;<a name="line.102"></a>
<span class="sourceLineNo">103</span>     *<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * @param key the key used when selecting the instance<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * @param p a {@code PooledObject} wrapping the instance to be destroyed<a name="line.105"></a>
<span class="sourceLineNo">106</span>     *<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * @throws Exception should be avoided as it may be swallowed by<a name="line.107"></a>
<span class="sourceLineNo">108</span>     *    the pool implementation.<a name="line.108"></a>
<span class="sourceLineNo">109</span>     *<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * @see #validateObject<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * @see KeyedObjectPool#invalidateObject<a name="line.111"></a>
<span class="sourceLineNo">112</span>     */<a name="line.112"></a>
<span class="sourceLineNo">113</span>    void destroyObject(K key, PooledObject&lt;V&gt; p) throws Exception;<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span>    /**<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * Destroys an instance no longer needed by the pool, using the provided {@link DestroyMode}.<a name="line.116"></a>
<span class="sourceLineNo">117</span>     *<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * @param key the key used when selecting the instance<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * @param p a {@code PooledObject} wrapping the instance to be destroyed<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * @param destroyMode DestroyMode providing context to the factory<a name="line.120"></a>
<span class="sourceLineNo">121</span>     *<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * @throws Exception should be avoided as it may be swallowed by<a name="line.122"></a>
<span class="sourceLineNo">123</span>     *    the pool implementation.<a name="line.123"></a>
<span class="sourceLineNo">124</span>     *<a name="line.124"></a>
<span class="sourceLineNo">125</span>     * @see #validateObject<a name="line.125"></a>
<span class="sourceLineNo">126</span>     * @see KeyedObjectPool#invalidateObject<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * @see #destroyObject(Object, PooledObject)<a name="line.127"></a>
<span class="sourceLineNo">128</span>     * @see DestroyMode<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * @since 2.9.0<a name="line.129"></a>
<span class="sourceLineNo">130</span>     */<a name="line.130"></a>
<span class="sourceLineNo">131</span>    default void destroyObject(final K key, final PooledObject&lt;V&gt; p, final DestroyMode destroyMode) throws Exception {<a name="line.131"></a>
<span class="sourceLineNo">132</span>        destroyObject(key, p);<a name="line.132"></a>
<span class="sourceLineNo">133</span>    }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span>    /**<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * Creates an instance that can be served by the pool and<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * wrap it in a {@link PooledObject} to be managed by the pool.<a name="line.137"></a>
<span class="sourceLineNo">138</span>     *<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * @param key the key used when constructing the object<a name="line.139"></a>
<span class="sourceLineNo">140</span>     *<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * @return a {@code PooledObject} wrapping an instance that can<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * be served by the pool.<a name="line.142"></a>
<span class="sourceLineNo">143</span>     *<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * @throws Exception if there is a problem creating a new instance,<a name="line.144"></a>
<span class="sourceLineNo">145</span>     *    this will be propagated to the code requesting an object.<a name="line.145"></a>
<span class="sourceLineNo">146</span>     */<a name="line.146"></a>
<span class="sourceLineNo">147</span>    PooledObject&lt;V&gt; makeObject(K key) throws Exception;<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span>    /**<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * Uninitializes an instance to be returned to the idle object pool.<a name="line.150"></a>
<span class="sourceLineNo">151</span>     *<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * @param key the key used when selecting the object<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * @param p a {@code PooledObject} wrapping the instance to be passivated<a name="line.153"></a>
<span class="sourceLineNo">154</span>     *<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * @throws Exception if there is a problem passivating {@code obj},<a name="line.155"></a>
<span class="sourceLineNo">156</span>     *    this exception may be swallowed by the pool.<a name="line.156"></a>
<span class="sourceLineNo">157</span>     *<a name="line.157"></a>
<span class="sourceLineNo">158</span>     * @see #destroyObject<a name="line.158"></a>
<span class="sourceLineNo">159</span>     */<a name="line.159"></a>
<span class="sourceLineNo">160</span>    void passivateObject(K key, PooledObject&lt;V&gt; p) throws Exception;<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span>    /**<a name="line.162"></a>
<span class="sourceLineNo">163</span>     * Ensures that the instance is safe to be returned by the pool.<a name="line.163"></a>
<span class="sourceLineNo">164</span>     *<a name="line.164"></a>
<span class="sourceLineNo">165</span>     * @param key the key used when selecting the object<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * @param p a {@code PooledObject} wrapping the instance to be validated<a name="line.166"></a>
<span class="sourceLineNo">167</span>     *<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * @return {@code false} if {@code obj} is not valid and should<a name="line.168"></a>
<span class="sourceLineNo">169</span>     *         be dropped from the pool, {@code true} otherwise.<a name="line.169"></a>
<span class="sourceLineNo">170</span>     */<a name="line.170"></a>
<span class="sourceLineNo">171</span>    boolean validateObject(K key, PooledObject&lt;V&gt; p);<a name="line.171"></a>
<span class="sourceLineNo">172</span>}<a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>




























































</pre>
</div>
</body>
</html>
